feat(costs): add generic custodial stored-value accounts#140
Draft
JaeLeex wants to merge 2 commits into
Draft
Conversation
Codecov Report❌ Patch coverage is 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Adds the generic
nunchi-costsmodule for account-scoped metering and opt-in custodial stored value.Why grants are separate from paid credits
This is a provenance split, not a second currency: both are credits and both can pay for usage, but they represent different economic claims.
Keeping only one aggregate balance would make it impossible to determine what may be refunded, what must expire, or why a particular credit was issued and consumed. It could also cause promotional value to be treated as refundable paid value.
Flow
Billingwriter records a payment as a paid lot; theAdjustmentwriter records an entitlement or promotion as a grant lot.Ingestwriter reserves or records usage. Allocation is deterministic: unexpired grants are consumed first (earliest expiry first), then paid lots.This preserves the customer-facing experience of one spendable credit pool while keeping refund, expiry, authorization, and accounting rules correct and auditable.
Scope boundary
This PR contains reusable SDK primitives only.
The existing aggregate API remains available for metering compatibility. The stored-value path is opt-in and versioned.
Validation
cargo fmt --package nunchi-costs -- --checkcargo test -p nunchi-costs --all-features— 25 tests passcargo clippy -p nunchi-costs --all-features -- -D warningsgit diff --check origin/main...HEADRequested review
Please focus on the account-core API, writer authority boundaries, serialization compatibility, grant-first allocation, reservation invariants, and paid-lot refund rules.